<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the HtmlEscapeMode class from the dart:convert library, for the Dart programming language.">
  <title>HtmlEscapeMode class - dart:convert library - Dart API</title>
  <!-- required because all the links are pseudo-absolute -->
  <base href="..">

  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  <link rel="stylesheet" href="static-assets/github.css">
  <link rel="stylesheet" href="static-assets/styles.css">
  <link rel="icon" href="static-assets/favicon.png">
  
</head>

<body>

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="index.html">shake</a></li>
    <li><a href="dart-convert/dart-convert-library.html">dart:convert</a></li>
    <li class="self-crumb">HtmlEscapeMode class</li>
  </ol>
  <div class="self-name">HtmlEscapeMode</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>

  <div id="dartdoc-sidebar-left" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
      <form class="search-sidebar" role="search">
        <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
      </form>
    </header>
    
    <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
      <li><a href="index.html">shake</a></li>
      <li><a href="dart-convert/dart-convert-library.html">dart:convert</a></li>
      <li class="self-crumb">HtmlEscapeMode class</li>
    </ol>
    
    <h5>dart:convert library</h5>
    <ol>
      <li class="section-title"><a href="dart-convert/dart-convert-library.html#classes">Classes</a></li>
      <li><a href="dart-convert/AsciiCodec-class.html">AsciiCodec</a></li>
      <li><a href="dart-convert/AsciiDecoder-class.html">AsciiDecoder</a></li>
      <li><a href="dart-convert/AsciiEncoder-class.html">AsciiEncoder</a></li>
      <li><a href="dart-convert/Base64Codec-class.html">Base64Codec</a></li>
      <li><a href="dart-convert/Base64Decoder-class.html">Base64Decoder</a></li>
      <li><a href="dart-convert/Base64Encoder-class.html">Base64Encoder</a></li>
      <li><a href="dart-convert/ByteConversionSink-class.html">ByteConversionSink</a></li>
      <li><a href="dart-convert/ByteConversionSinkBase-class.html">ByteConversionSinkBase</a></li>
      <li><a href="dart-convert/ChunkedConversionSink-class.html">ChunkedConversionSink</a></li>
      <li><a href="dart-convert/ClosableStringSink-class.html">ClosableStringSink</a></li>
      <li><a href="dart-convert/Codec-class.html">Codec</a></li>
      <li><a href="dart-convert/Converter-class.html">Converter</a></li>
      <li><a href="dart-convert/Encoding-class.html">Encoding</a></li>
      <li><a href="dart-convert/HtmlEscape-class.html">HtmlEscape</a></li>
      <li><a href="dart-convert/HtmlEscapeMode-class.html">HtmlEscapeMode</a></li>
      <li><a href="dart-convert/JsonCodec-class.html">JsonCodec</a></li>
      <li><a href="dart-convert/JsonDecoder-class.html">JsonDecoder</a></li>
      <li><a href="dart-convert/JsonEncoder-class.html">JsonEncoder</a></li>
      <li><a href="dart-convert/JsonUtf8Encoder-class.html">JsonUtf8Encoder</a></li>
      <li><a href="dart-convert/Latin1Codec-class.html">Latin1Codec</a></li>
      <li><a href="dart-convert/Latin1Decoder-class.html">Latin1Decoder</a></li>
      <li><a href="dart-convert/Latin1Encoder-class.html">Latin1Encoder</a></li>
      <li><a href="dart-convert/LineSplitter-class.html">LineSplitter</a></li>
      <li><a href="dart-convert/StringConversionSink-class.html">StringConversionSink</a></li>
      <li><a href="dart-convert/StringConversionSinkBase-class.html">StringConversionSinkBase</a></li>
      <li><a href="dart-convert/StringConversionSinkMixin-class.html">StringConversionSinkMixin</a></li>
      <li><a href="dart-convert/Utf8Codec-class.html">Utf8Codec</a></li>
      <li><a href="dart-convert/Utf8Decoder-class.html">Utf8Decoder</a></li>
      <li><a href="dart-convert/Utf8Encoder-class.html">Utf8Encoder</a></li>
    
    
      <li class="section-title"><a href="dart-convert/dart-convert-library.html#constants">Constants</a></li>
      <li><a href="dart-convert/ascii-constant.html">ascii</a></li>
      <li><a href="dart-convert/base64-constant.html">base64</a></li>
      <li><a href="dart-convert/base64Url-constant.html">base64Url</a></li>
      <li><a href="dart-convert/htmlEscape-constant.html">htmlEscape</a></li>
      <li><a href="dart-convert/json-constant.html">json</a></li>
      <li><a href="dart-convert/latin1-constant.html">latin1</a></li>
      <li><a href="dart-convert/unicodeBomCharacterRune-constant.html">unicodeBomCharacterRune</a></li>
      <li><a href="dart-convert/unicodeReplacementCharacterRune-constant.html">unicodeReplacementCharacterRune</a></li>
      <li><a href="dart-convert/utf8-constant.html">utf8</a></li>
    
    
      <li class="section-title"><a href="dart-convert/dart-convert-library.html#functions">Functions</a></li>
      <li><a href="dart-convert/base64Decode.html">base64Decode</a></li>
      <li><a href="dart-convert/base64Encode.html">base64Encode</a></li>
      <li><a href="dart-convert/base64UrlEncode.html">base64UrlEncode</a></li>
      <li><a href="dart-convert/jsonDecode.html">jsonDecode</a></li>
      <li><a href="dart-convert/jsonEncode.html">jsonEncode</a></li>
    
    
    
      <li class="section-title"><a href="dart-convert/dart-convert-library.html#exceptions">Exceptions</a></li>
      <li><a href="dart-convert/JsonCyclicError-class.html">JsonCyclicError</a></li>
      <li><a href="dart-convert/JsonUnsupportedObjectError-class.html">JsonUnsupportedObjectError</a></li>
    </ol>
  </div>

  <div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
      <div><h1>HtmlEscapeMode class </h1></div>

    <section class="desc markdown">
      <p>HTML escape modes.</p>
<p>Allows specifying a mode for HTML escaping that depend on the context
where the escaped result is going to be used.
The relevant contexts are:</p><ul><li>as text content of an HTML element.</li><li>as value of a (single- or double-) quoted attribute value.</li></ul>
<p>All modes require escaping of <code>&amp;</code> (ampersand) characters, and may
enable escaping of more characters.</p>
<p>Custom escape modes can be created using the <a href="dart-convert/HtmlEscapeMode/HtmlEscapeMode.html">HtmlEscapeMode.HtmlEscapeMode</a>
constructor.</p>
    </section>
    

    <section class="summary offset-anchor" id="constructors">
      <h2>Constructors</h2>

      <dl class="constructor-summary-list">
        <dt id="HtmlEscapeMode" class="callable">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/HtmlEscapeMode.html">HtmlEscapeMode</a></span><span class="signature">({<span class="parameter" id="-param-name"><span class="type-annotation"><a href="dart-core/String-class.html">String</a></span> <span class="parameter-name">name</span>: <span class="default-value">"custom"</span>, </span> <span class="parameter" id="-param-escapeLtGt"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">escapeLtGt</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-escapeQuot"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">escapeQuot</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-escapeApos"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">escapeApos</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="-param-escapeSlash"><span class="type-annotation"><a href="dart-core/bool-class.html">bool</a></span> <span class="parameter-name">escapeSlash</span>: <span class="default-value">false</span></span> })</span>
        </dt>
        <dd>
          Create a custom escaping mode. <a href="dart-convert/HtmlEscapeMode/HtmlEscapeMode.html">[...]</a>
          <div class="constructor-modifier features">const</div>
        </dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="escapeApos" class="property">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/escapeApos.html">escapeApos</a></span>
          <span class="signature">&#8594; <a href="dart-core/bool-class.html">bool</a></span>         
        </dt>
        <dd>
          Whether to escape "'" (apostrophe).
                  <div class="features">final</div>
</dd>
        <dt id="escapeLtGt" class="property">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/escapeLtGt.html">escapeLtGt</a></span>
          <span class="signature">&#8594; <a href="dart-core/bool-class.html">bool</a></span>         
        </dt>
        <dd>
          Whether to escape '&lt;' and '&gt;'.
                  <div class="features">final</div>
</dd>
        <dt id="escapeQuot" class="property">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/escapeQuot.html">escapeQuot</a></span>
          <span class="signature">&#8594; <a href="dart-core/bool-class.html">bool</a></span>         
        </dt>
        <dd>
          Whether to escape '"' (quote).
                  <div class="features">final</div>
</dd>
        <dt id="escapeSlash" class="property">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/escapeSlash.html">escapeSlash</a></span>
          <span class="signature">&#8594; <a href="dart-core/bool-class.html">bool</a></span>         
        </dt>
        <dd>
          Whether to escape "/" (forward slash, solidus). <a href="dart-convert/HtmlEscapeMode/escapeSlash.html">[...]</a>
                  <div class="features">final</div>
</dd>
        <dt id="hashCode" class="property inherited">
          <span class="name"><a href="dart-core/Object/hashCode.html">hashCode</a></span>
          <span class="signature">&#8594; <a href="dart-core/int-class.html">int</a></span>         
        </dt>
        <dd class="inherited">
          The hash code for this object. <a href="dart-core/Object/hashCode.html">[...]</a>
                  <div class="features">read-only, inherited</div>
</dd>
        <dt id="runtimeType" class="property inherited">
          <span class="name"><a href="dart-core/Object/runtimeType.html">runtimeType</a></span>
          <span class="signature">&#8594; <a href="dart-core/Type-class.html">Type</a></span>         
        </dt>
        <dd class="inherited">
          A representation of the runtime type of the object.
                  <div class="features">read-only, inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-methods">
      <h2>Methods</h2>
      <dl class="callables">
        <dt id="toString" class="callable">
          <span class="name"><a href="dart-convert/HtmlEscapeMode/toString.html">toString</a></span><span class="signature">(<wbr>)
            <span class="returntype parameter">&#8594; <a href="dart-core/String-class.html">String</a></span>
          </span>
                  </dt>
        <dd>
          Returns a string representation of this object.
                  <div class="features">override</div>
</dd>
        <dt id="noSuchMethod" class="callable inherited">
          <span class="name"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
            <span class="returntype parameter">&#8594; dynamic</span>
          </span>
                  </dt>
        <dd class="inherited">
          Invoked when a non-existent method or property is accessed. <a href="dart-core/Object/noSuchMethod.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="operators">
      <h2>Operators</h2>
      <dl class="callables">
        <dt id="operator ==" class="callable inherited">
          <span class="name"><a href="dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>)
            <span class="returntype parameter">&#8594; <a href="dart-core/bool-class.html">bool</a></span>
          </span>
                  </dt>
        <dd class="inherited">
          The equality operator. <a href="dart-core/Object/operator_equals.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>



    <section class="summary offset-anchor" id="constants">
      <h2>Constants</h2>

      <dl class="properties">
        <dt id="attribute" class="constant">
          <span class="name "><a href="dart-convert/HtmlEscapeMode/attribute-constant.html">attribute</a></span>
          <span class="signature">&#8594; const <a href="dart-convert/HtmlEscapeMode-class.html">HtmlEscapeMode</a></span>
                  </dt>
        <dd>
          Escaping mode for text going into double-quoted HTML attribute values. <a href="dart-convert/HtmlEscapeMode/attribute-constant.html">[...]</a>
                  
  <div>
            <span class="signature"><code>const HtmlEscapeMode._(&#39;attribute&#39;, true, true, false, false)</code></span>
          </div>
        </dd>
        <dt id="element" class="constant">
          <span class="name "><a href="dart-convert/HtmlEscapeMode/element-constant.html">element</a></span>
          <span class="signature">&#8594; const <a href="dart-convert/HtmlEscapeMode-class.html">HtmlEscapeMode</a></span>
                  </dt>
        <dd>
          Escaping mode for text going into HTML element content. <a href="dart-convert/HtmlEscapeMode/element-constant.html">[...]</a>
                  
  <div>
            <span class="signature"><code>const HtmlEscapeMode._(&#39;element&#39;, true, false, false, false)</code></span>
          </div>
        </dd>
        <dt id="sqAttribute" class="constant">
          <span class="name "><a href="dart-convert/HtmlEscapeMode/sqAttribute-constant.html">sqAttribute</a></span>
          <span class="signature">&#8594; const <a href="dart-convert/HtmlEscapeMode-class.html">HtmlEscapeMode</a></span>
                  </dt>
        <dd>
          Escaping mode for text going into single-quoted HTML attribute values. <a href="dart-convert/HtmlEscapeMode/sqAttribute-constant.html">[...]</a>
                  
  <div>
            <span class="signature"><code>const HtmlEscapeMode._(&#39;attribute&#39;, true, false, true, false)</code></span>
          </div>
        </dd>
        <dt id="unknown" class="constant">
          <span class="name "><a href="dart-convert/HtmlEscapeMode/unknown-constant.html">unknown</a></span>
          <span class="signature">&#8594; const <a href="dart-convert/HtmlEscapeMode-class.html">HtmlEscapeMode</a></span>
                  </dt>
        <dd>
          Default escaping mode which escape all characters. <a href="dart-convert/HtmlEscapeMode/unknown-constant.html">[...]</a>
                  
  <div>
            <span class="signature"><code>const HtmlEscapeMode._(&#39;unknown&#39;, true, true, true, true)</code></span>
          </div>
        </dd>
      </dl>
    </section>

  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
    <ol>
      <li class="section-title"><a href="dart-convert/HtmlEscapeMode-class.html#constructors">Constructors</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/HtmlEscapeMode.html">HtmlEscapeMode</a></li>
    
      <li class="section-title">
        <a href="dart-convert/HtmlEscapeMode-class.html#instance-properties">Properties</a>
      </li>
      <li><a href="dart-convert/HtmlEscapeMode/escapeApos.html">escapeApos</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/escapeLtGt.html">escapeLtGt</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/escapeQuot.html">escapeQuot</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/escapeSlash.html">escapeSlash</a></li>
      <li class="inherited"><a href="dart-core/Object/hashCode.html">hashCode</a></li>
      <li class="inherited"><a href="dart-core/Object/runtimeType.html">runtimeType</a></li>
    
      <li class="section-title"><a href="dart-convert/HtmlEscapeMode-class.html#instance-methods">Methods</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/toString.html">toString</a></li>
      <li class="inherited"><a href="dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
    
      <li class="section-title inherited"><a href="dart-convert/HtmlEscapeMode-class.html#operators">Operators</a></li>
      <li class="inherited"><a href="dart-core/Object/operator_equals.html">operator ==</a></li>
    
    
    
      <li class="section-title"><a href="dart-convert/HtmlEscapeMode-class.html#constants">Constants</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/attribute-constant.html">attribute</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/element-constant.html">element</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/sqAttribute-constant.html">sqAttribute</a></li>
      <li><a href="dart-convert/HtmlEscapeMode/unknown-constant.html">unknown</a></li>
    </ol>
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    shake 0.1.0
  </span>

  
</footer>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/highlight.pack.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>


</body>

</html>
